Component org.nuxeo.ecm.platform.suggestbox.service.SuggestionService

In bundle org.nuxeo.ecm.platform.suggestbox.core

Documentation

The SuggestionService provides a pluggable way to generate explicit suggestions for user actions / intents based on contextual text user input and the content of repositories and user directories for instance.

The default use-case is to implement the auto-suggest feature in the top right search box of the Nuxeo DM user interface for quick keyboard based navigation in the repository.

Requirements

org.nuxeo.ecm.core.api.repository.RepositoryManager

Resolution Order

480

The resolution order represents the order in which this component has been resolved by the Nuxeo Runtime framework.
You can influence this order by adding "require" tags in your component declaration, to make sure it is resolved after another component.

Start Order

851

The start order represents the order in which this component has been started by the Nuxeo Runtime framework.
This number is interesting to tweak if your Java component interacts with other components, and needs to be started before or after another one.
It can be changed by implementing the method "Component#getApplicationStartedOrder()" on your Java component: components are sorted according to this reference value, in increasing order.
The default value is 1000, and the repository initialization uses number 100. Negative values can also be used.

Implementation

Class: org.nuxeo.ecm.platform.suggestbox.service.SuggestionServiceImpl

Services

org.nuxeo.ecm.platform.suggestbox.service.SuggestionService

Extension Points

XML Source

<?xml version="1.0"?>
<component name="org.nuxeo.ecm.platform.suggestbox.service.SuggestionService">
  <require>org.nuxeo.ecm.core.api.repository.RepositoryManager</require>

  <implementation
    class="org.nuxeo.ecm.platform.suggestbox.service.SuggestionServiceImpl" />

  <service>
    <provide
      interface="org.nuxeo.ecm.platform.suggestbox.service.SuggestionService" />
  </service>

  <documentation>
    The SuggestionService provides a pluggable way to
    generate explicit suggestions for user actions / intents based on
    contextual text user input and the content of repositories and user
    directories for instance.

    The default use-case is to implement the
    auto-suggest feature in the top right search box of the Nuxeo DM
    user interface for quick keyboard based navigation in the
    repository.
  </documentation>

  <extension-point name="suggesters">

    <documentation>
      Extension point for registering named suggester
      implementations and
      their parameters.

      Suggester implementations
      should implement the
      "org.nuxeo.ecm.platform.suggestbox.service.Suggester" interface.
    </documentation>

    <object
      class="org.nuxeo.ecm.platform.suggestbox.service.descriptors.SuggesterDescriptor" />

  </extension-point>

  <extension-point name="suggesterGroups">

    <documentation>
      Extension point for assembling several named
      suggesters into a named aggregate user interface element.

      For instance the top right search box can use a specific
      global search-centric SuggesterGroup.
    </documentation>

    <object
      class="org.nuxeo.ecm.platform.suggestbox.service.descriptors.SuggesterGroupDescriptor" />
  </extension-point>

  <extension-point name="suggestionHandlers">

    <documentation>
      Extension point for registering Content Automation
      Operations or Chains as handler for the suggestion selected by the
      user (for a given group and suggestion type).
    </documentation>

    <object
      class="org.nuxeo.ecm.platform.suggestbox.service.descriptors.SuggestionHandlerDescriptor" />
  </extension-point>

</component>